﻿//	------------------------------------------------------------------------------
//                                       _                          
//              _ __ ___   ___ _ __ ___ | |__  _ __ __ _ _ __   ___ 
//             | '_ ` _ \ / _ \ '_ ` _ \| '_ \| '__/ _` | '_ \ / _ \
//             | | | | | |  __/ | | | | | |_) | | | (_| | | | |  __/
//             |_| |_| |_|\___|_| |_| |_|_.__/|_|  \__,_|_| |_|\___|
//                                                     
//	------------------------------------------------------------------------------

#region - License -
//
//	------------------------------------------------------------------------------                                                   
//	         Copyright (c) 2010 Peter Vyvey (peter.vyvey@chiliware.be)
//	------------------------------------------------------------------------------
//
//
//	This file is part of CHILIWARE MEMBRANE.
//
//	CHILIWARE MEMBRANE is free software: you can redistribute it and/or modify
//	it under the terms of the GNU Lesser General Public License as published by
//	the Free Software Foundation, either version 3 of the License, or
//	(at your option) any later version.
//
//	CHILIWARE MEMBRANE is distributed in the hope that it will be useful,
//	but WITHOUT ANY WARRANTY; without even the implied warranty of
//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//	GNU Lesser General Public License for more details.
//
//	You should have received a copy of the GNU Lesser General Public License
//	along with CHILIWARE MEMBRANE.  If not, see <http://www.gnu.org/licenses/>.
//
//
#endregion

#region - Changes -
//
//	peter.vyvey@chiliware.be		2010-08-30		Created
//
#endregion

#region - Using -



#endregion

namespace Chiliware.Membrane.Entity
{
	#region - AbstractEntity -

	/// <summary>
	/// Base class for the domain entity classes.
	/// </summary>
	/// <typeparam name="T"></typeparam>
	public abstract class AbstractEntity<T>
		: ComparableObject, IEntity<T>
	{
		#region - Constructors - 

		/// <summary>
		/// Default constructor.
		/// </summary>
		protected AbstractEntity()
			: base() 
		{
			this.InitializeObject();
		}

		/// <summary>
		/// Constructor with parameter.
		/// </summary>
		/// <param name="id">The entity identifier value.</param>
		protected AbstractEntity(T id)
			: this()
		{
			this.ID = id;
		}

		#endregion
		
		#region - Properties -

		/// <summary>
		/// The entity identifier.
		/// </summary>
		public abstract T ID { get; set; }

		#endregion

		#region - Public methods -

		/// <summary>
		/// Returns TRUE if the entity is in transtient state, return FALSE otherwise.
		/// </summary>
		/// <returns>TRUE if the entity is in TRANSIENT state, FALSE otherwise.</returns>
		public bool IsTransient()
		{
			return this.ID.Equals(default(T));
		}

		#endregion

		#region - Private & protected methods -

		/// <summary>
		/// Initializes the object.
		/// </summary>
		private void InitializeObject()
		{
			this.ID = default(T);
		}

		#endregion
	}

	#endregion
}
